/*
 * Copyright 2019-present HiveMQ GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.hivemq.extensions.events;

import com.hivemq.extension.sdk.api.annotations.NotNull;
import com.hivemq.extension.sdk.api.events.client.ClientLifecycleEventListenerProvider;

import java.util.Map;

/**
 * @author Florian Limpöck
 * @since 4.0.0
 */
public interface LifecycleEventListeners {

    /**
     * add a ClientLifecycleEventListenerProvider to eventListenersMap
     *
     * @param provider the provider to add
     */
    void addClientLifecycleEventListenerProvider(@NotNull ClientLifecycleEventListenerProvider provider);

    /**
     * @return a map of extension ids and ClientLifecycleEventListenerProvider, sorted descending by extension priority.
     */
    @NotNull Map<@NotNull String, @NotNull ClientLifecycleEventListenerProvider> getClientLifecycleEventListenerProviderMap();

}
